Channel Settings

addRoleNo

Identifier of an additional role to include with all users, registered and anonymous. If specified, the value must be the identifier of a valid KsRole. If not specified, no additional role is added to users.

adminEmailAddress

Email address of the site administrator. The system sends important notifications, such as background task failures, to this address.

customerServiceEmailAddress

The reply-to email address of the back-office customer service person or distribution list. If not specified, the system uses the value of the "from" attribute of the <smtp> child element of the <mailSettings> element. Note that this value is used as the reply-to email address, not the from email address.

defaultLanguage

Specifies the default language for the channel. If not specified, the system uses "eng" for English. If specified, the value must be one of the following: eng,zho,dan,nld,fin,fra,deu,ita,kor,por,spa,swe,tur

registrationType

Identifies the built-in registration method(s) for the web site. If not specified, no built-in registration type is active. If specified, it must be one or multiple of these registration types: "Public", "Request", "Token", and "Customer". If multiple types are chosen, use a comma (,) to separate types. (e.g. "Request, Token, Customer"). The order of your chosen types will be the order they show up on the sign in page.

Public - Any user can register and access it immediately.

Request - A user provides registration information and an email is sent to the back-office for approval. Administrators would then setup the user and notify the user when they can log on to the site.

Token - A user has been previously sent a registration token representing their existing company account. They enter this token along with their company number, plus their contact information. If the decrypted token matches the entered company account number, a new contact is created for the specified company. This option requires some coordination between your marketing department and Kore in order to generate the tokens to be sent to existing customers.

Customer - Allows the user to enter account-level information along with their known account number in the back office. If a match is found, a new user account will be established and linked to the matching back office account.

customRegistrationPageName

The name of a page that provides user registration services for the Request registrationType.

newAccountTemplateNo

Identifier of the template to use when formatting emails sent to end-users that provides information for accessing a new account. Value must be the identifier of a valid notification template in the system. If specified, the value must be the NotificationTemplateNo in KsNotificationTemplates. If not specified, an error is logged and no email is sent. Refer to the Notification Template Listing topic for more information.

verifyEmailTemplateNo

Identifies the notification template to use when formatting emails sent to the customer that provides the verification code.

applicationRootUrl

The URL of the root of the web site. This is typically only used by background processes that need to provide references to the website, but do not operate a web context. By default, this is used for the activate new account email only.

requestAccountTemplateNo

Identifies the notification template to use when formatting emails sent to the back-office that provides information needed to evaluate and create a new account. This setting is used in conjunction with the registrationType setting of “Request”. If specified, the value must be the NotificationTemplateNo of an existing Notification Template. If not specified, an error is logged and no email is sent.
Note: If a notification template is used, the object context for the template should be based on Person.AccountRequest.AccountRequest.

resetPasswordTemplateNo

Identifies the notification template to use when formatting emails sent to end-users that provides information for resetting a password. If specified, the value must be the NotificationTemplateNo for an existing Notification Template. If not specified, an error is displayed, the error is logged, and no email is sent.
Note: If a notification template is used, the object context for the template should be based on KSUser.KSUser.

transactionRootTag

The root element name to use for all posted XML messages. Posting of transactional messages is setup using the Events & Actions system in KommerceServer and is used for integration purposes. If a non-empty value is specified, the system will envelop each posted XML message with an element by this name. If the value is empty, the system will not add an additional enclosing root element to the transaction XML. For most integrations using Kourier in the back office, this setting should be “KommerceServer”.

transactionTag

The transaction element to use for all posted XML messages. Posting of transactional messages is setup using the Events & Actions system in KommerceServer and is used for integration purposes. If a non-empty value is specified, the system will envelop each posted XML message with an element by this name. This setting is for the DataFlo ERP system primarily for downward compatibility for a previous version of KommerceServer that supported multiple transactions per XML message. This is no longer supported as there is a 1-to-1 ratio between a single transaction per XML message posted.

enableActionService

If true, the system runs the action service as a background task. If false, the action service does not run. If not specified, the default value is true, so the system runs the action service.

menuId

If specified, the identifier for the primary menu.

serviceApiToken

If specified, the token used to validate service API requests. The token should be sent in the X-KsApiToken header.

isAdvancedCms

If true, the system enables advanced CMS features. If false, advanced CMS features are not enabled. If not specified, the default value is false which means that advanced CMS features are not enabled.

siteName

Name of site (e.g, "San Diego, CA").

siteGroup

Group of sites to which this site belongs.

accessLogRetentionDays

The number of days to retain access logs for. A value of 0 disables access logging. Default is 0.

requireLinkedContactOnSignin

Determines whether a contact is required for a user in order to be able to sign in. If not specified, the default value is true to required a linked contact.

eventActionRetryCount

The number of time to retry a ks_action_queue item before removing it from the queue. Default is 5.